CimDevicePoint Json Schema

In This Topic

Description

object contains the device information for a CIMPLICITY point.

Overview

CimDevicePoint

object contains the device information for a CIMPLICITY point.

Address : string

is a string indicating the device specific address of the point

AddressOffset : integer

is an integer indicating the address offset of the point. Typically used for addressing a boolean point in an analog domain

AddressType : CimMMSAddressTypeEnum

MMS types

AnalogDeadband : string

is an variant containing the analog deadband for the point. The point will not be updated until a change that exceeds the deadband is read.

DelayLoad : boolean

is boolean indicating the point should only be loaded into memory if it's requested by an application. Defaults to False.

DeviceID : string

is a string indicating the device the point is on

JustInTime : boolean

is a boolean used to enable or disable Just-In-Time. Note this is only available when this is a class Data Item comming from the Class configuration

PollAfterSetpoint : boolean

is boolean indicating if the point should be polled immediately after a setpoint. If False, the point is not polled until the next scheduled scan cycle

ScanRate : integer

is an integer indicating the scan rate of the point in multiples of the base scan rate of the communications port.

TriggerType : CimDeviceTriggerEnum

defines the trigger condition for a device point. See the Point Configuration documentation for additional information

TriggerValue : string

is variant containing the trigger value. Trigger value is used when specifying a CimDevicePoint.TriggerType relation that requires a value

UpdateCriteria : CimUpdateCriteriaEnum

defines update criterias available for device points. The particular types of update that are actually available depend on the device communication module being used

Properties

Name	Description	Data Type
Address	is a string indicating the device specific address of the point	string
AddressOffset	is an integer indicating the address offset of the point. Typically used for addressing a boolean point in an analog domain	integer
AddressType	MMS types	CimMMSAddressTypeEnum
AnalogDeadband	is an variant containing the analog deadband for the point. The point will not be updated until a change that exceeds the deadband is read.	string
DelayLoad	is boolean indicating the point should only be loaded into memory if it's requested by an application. Defaults to False.	boolean
DeviceID	is a string indicating the device the point is on	string
JustInTime	is a boolean used to enable or disable Just-In-Time. Note this is only available when this is a class Data Item comming from the Class configuration	boolean
PollAfterSetpoint	is boolean indicating if the point should be polled immediately after a setpoint. If False, the point is not polled until the next scheduled scan cycle	boolean
ScanRate	is an integer indicating the scan rate of the point in multiples of the base scan rate of the communications port.	integer
TriggerType	defines the trigger condition for a device point. See the Point Configuration documentation for additional information	CimDeviceTriggerEnum
TriggerValue	is variant containing the trigger value. Trigger value is used when specifying a CimDevicePoint.TriggerType relation that requires a value	string
UpdateCriteria	defines update criterias available for device points. The particular types of update that are actually available depend on the device communication module being used	CimUpdateCriteriaEnum